ファイル送信
次の例は、HTTPリクエストの一部として単一ファイルまたは複数ファイルを送信する方法を示しています。
単一ファイルを送信する
これは単一ファイルをバイナリストリームとして送信します。Web APIアクション定義で別のコンテンツタイプヘッダー値が指定されていない限り、このコンテンツタイプを使用するとコンテンツタイプHTTPヘッダーはapplication/octet-streamに設定されます。
Web API定義
API定義内のアクションは、本文のコンテンツにPOSTメソッドと単一ファイルを使用します。ファイルパラメーター名は、このアクションを使用するプロセス内に[リリースノート]という名前の入力パラメーターを作成します。
プロセス
プロセススタジオでは、ファイルがインポートされたバイナリのデータ型の[ノート]というデータアイテムがプロセスに含まれています。
プロセス内のアクションステージは、API定義を使用して、入力パラメーターの値として[ノート]データアイテムを参照します。
APIが呼び出されると、データアイテムにインポートされたファイルがHTTPリクエストの一部として送信されます。
複数ファイルを送信する
multipart/form-data content-typeを使用して、1つのリクエストで複数ファイルが送信されます。
Web API定義
API定義内のアクションは、本文のコンテンツにPOSTメソッドと複数ファイルを使用します。ファイルパラメーター名は、このアクションを使用するプロセス内に[ドキュメント]という名前の入力パラメーターを作成します。
プロセス
プロセスには、ファイルいう名前のコレクションアイテムが含まれており、そこに多数のファイルがインポートされています。
入力パラメーターに渡されるコレクションは、次の指定されたスキーマを使用することが想定されます。
名前 |
データ型 |
必須 |
説明 |
---|---|---|---|
ファイル |
バイナリ |
True |
送信するファイル。 |
ファイル名 |
テキスト |
False |
マルチパートフォーム本文でこのファイルのセクションのファイル名ヘッダーを入力するために使用されます |
フィールド名 |
テキスト |
False |
マルチパートフォーム本文でこのファイルのセクションの名前ヘッダーを入力するために使用されます |
コンテンツタイプ |
テキスト |
False |
マルチパートフォーム本文でこのファイルのセクションのコンテンツタイプヘッダーを入力するために使用されます。値が指定されていない場合、デフォルトでapplication/octet-streamが使用されます。 |
コレクションを作成する際は、コレクションプロパティから[フィールドをインポート]をクリックし、必要なWeb APIアクションからパラメーターを選択して、必要なスキーマをインポートできます。
プロセス内のアクションステージは、API定義を使用して、入力パラメーターの値として[ファイル]データアイテムを参照します。
APIが呼び出されると、ファイルはHTTPリクエストの一部として送信されます。